docs: telemetry user guide, design spec, and test summary#364
docs: telemetry user guide, design spec, and test summary#364samikshya-db wants to merge 3 commits into
Conversation
Rebases the docs PR onto main now that #327 has landed. Drops all code changes from the diff; keeps only the new docs (docs/TELEMETRY.md, spec/telemetry-design.md, spec/telemetry-test-completion-summary.md) and swaps README's telemetry section to a short pointer to docs/TELEMETRY.md. Co-authored-by: Isaac
samikshya-db
force-pushed
the
telemetry-4-docs
branch
from
38437c5 to
ca55f0c
Compare
|
Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase ( |
Replace the verbose bulleted overview with a tight three-sentence blurb that names what's collected, where the opt-outs live, and points readers to docs/TELEMETRY.md for everything else. Co-authored-by: Isaac
|
Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase ( |
- docs/TELEMETRY.md: 717 → 123 lines. Drop duplicate privacy sections, long examples, architecture deep-dive. Fix the inaccurate "disabled by default" claim. Cross-reference IDBSQLClient.ts JSDoc for defaults so the doc can't drift. - spec/telemetry-design.md: 2538 → 125 lines. Drop the implementation checklist, exhaustive proto field table, and inline class bodies that mirrored lib/telemetry/*.ts. Keep architecture diagram, per-component responsibilities, export lifecycle, privacy/error/shutdown invariants. - spec/telemetry-test-completion-summary.md: 648 → 47 lines. Collapse per-component prose into a single table, drop verbose exit-criteria-verification and quality-metrics sections. Co-authored-by: Isaac
|
Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase ( |
samikshya-db
changed the title
1 participant
Summary
Docs-only follow-up to #327 (now merged). Adds the markdown that was split
out of the code PR to keep that review focused on emission / aggregation
logic. All four files were rewritten to be terse and to defer to the
source as the source of truth for defaults and exact field mappings.
docs/TELEMETRY.md(123 lines) — user-facing guide: what's collected,configuration options, opt-out precedence, multi-tenant SaaS warning,
troubleshooting, FAQ.
spec/telemetry-design.md(125 lines) — internal design: architecturediagram, per-component responsibilities, export lifecycle, privacy /
redaction, error-handling invariant, graceful shutdown.
spec/telemetry-test-completion-summary.md(47 lines) — coveragesummary for the telemetry unit + integration tests that landed in [4/7] Telemetry Event Emission and Aggregation #327.
README.md— trims the telemetry section to a short blurb that linksto
docs/TELEMETRY.md.Test plan
This pull request and its description were written by Isaac.